Kameleon-Plus  0.3.2
Public Member Functions | List of all members
ccmc::BATSRUSInterpolator Class Reference

TODO: brief description of BATSRUSInterpolator class. More...

#include <BATSRUSInterpolator.h>

Inheritance diagram for ccmc::BATSRUSInterpolator:
Inheritance graph
[legend]
Collaboration diagram for ccmc::BATSRUSInterpolator:
Collaboration graph
[legend]

Public Member Functions

 BATSRUSInterpolator (Model *modelReader)
 
float interpolate (const std::string &, const float &c0, const float &c1, const float &c2)
 
float interpolate (const std::string &, const float &c0, const float &c1, const float &c2, float &dc0, float &dc1, float &dc2)
 
float interpolate (const long &variable_id, const float &c0, const float &c1, const float &c2)
 
float interpolate (const long &variable_id, const float &c0, const float &c1, const float &c2, float &dc0, float &dc1, float &dc2)
 
virtual ~BATSRUSInterpolator ()
 
- Public Member Functions inherited from ccmc::Interpolator
 Interpolator ()
 
virtual float getConversionFactor (const std::string &)
 
virtual float getConversionFactor (const long &variable_id)
 
std::string getModelName ()
 
virtual ~Interpolator ()
 
void setModelReader (Model *reader)
 

Additional Inherited Members

- Protected Attributes inherited from ccmc::Interpolator
ModelmodelReader
 
std::string modelName
 

Detailed Description

TODO: brief description of BATSRUSInterpolator class.

TODO: full description of BATSRUSInterpolator class

Constructor & Destructor Documentation

ccmc::BATSRUSInterpolator::BATSRUSInterpolator ( Model modelReader)
Parameters
modelReaderPointer to the Model object containing the appropriate variable maps. BATSRUSInterpolator should be returned by a BATSRUS::createNewInterpolator() call.

They are stored as floats. Need to fetch them, and convert to int

Here is the call graph for this function:

ccmc::BATSRUSInterpolator::~BATSRUSInterpolator ( )
virtual

Destructor

Member Function Documentation

float ccmc::BATSRUSInterpolator::interpolate ( const std::string &  variable,
const float &  c0,
const float &  c1,
const float &  c2 
)
virtual
Parameters
variable
c0X component of the position
c1Y component of the position
c2Z component of the position
Returns

Implements ccmc::Interpolator.

Here is the call graph for this function:

float ccmc::BATSRUSInterpolator::interpolate ( const std::string &  variable,
const float &  c0,
const float &  c1,
const float &  c2,
float &  dc0,
float &  dc1,
float &  dc2 
)
virtual

Interpolation method. Note that using the variable ID is significantly faster than using the variable string.

Parameters
variableThe input variable.
c0X component of the position
c1Y component of the position
c2Z component of the position
dc0Reference to a variable to store the delta for component 0
dc1Reference to a variable to store the delta for component 1
dc2Reference to a variable to store the delta for component 2
Returns
The interpolated value at position (c0,c1,c2) with deltas (dc0,dc1,dc2)

end of if new position loop

Implements ccmc::Interpolator.

Here is the call graph for this function:

float ccmc::BATSRUSInterpolator::interpolate ( const long &  variable_id,
const float &  c0,
const float &  c1,
const float &  c2 
)
virtual
Parameters
variable_id
c0X component of the position
c1Y component of the position
c2Z component of the position
Returns

Implements ccmc::Interpolator.

Here is the call graph for this function:

float ccmc::BATSRUSInterpolator::interpolate ( const long &  variable_id,
const float &  c0,
const float &  c1,
const float &  c2,
float &  dc0,
float &  dc1,
float &  dc2 
)
virtual

Interpolation method. Note that using the variable ID is significantly faster than using the variable string.

Parameters
variable_idA long representing the variable ID.
c0X component of the position
c1Y component of the position
c2Z component of the position
dc0Reference to a variable to store the delta for component 0
dc1Reference to a variable to store the delta for component 1
dc2Reference to a variable to store the delta for component 2
Returns
The interpolated value at position (c0,c1,c2) with deltas (dc0,dc1,dc2)

end of if new position loop

Implements ccmc::Interpolator.

Here is the call graph for this function:


The documentation for this class was generated from the following files: